Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add params file docs to usage.md in template #2173

Merged
merged 7 commits into from
Jan 30, 2023
Merged

Add params file docs to usage.md in template #2173

merged 7 commits into from
Jan 30, 2023

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented Jan 27, 2023

To address issues as discussed in: https://nfcore.slack.com/archives/CE6SDBX2A/p1674599225438509

Text is copied from @d4straub 's text in nf-core/ampliseq with minor modifications and extensions.

I've also tagged myself as contributors, to start that tradition as discussed in the maintainers channel (so each release CHANGELOG shows who contirbuted)

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@jfy133 jfy133 changed the base branch from master to dev January 27, 2023 08:08
@github-actions
Copy link
Contributor

This PR is against the master branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @jfy133,

It looks like this pull-request is has been made against the nf-core/tools master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the nf-core/tools dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.

Thanks again for your contribution!

@jfy133
Copy link
Member Author

jfy133 commented Jan 27, 2023

@nf-core-bot fix linting

@codecov
Copy link

codecov bot commented Jan 27, 2023 •
edited
Loading

Codecov Report

Merging #2173 (579a0c3) into dev (9ca438b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #2173   +/-   ##
=======================================
  Coverage   71.49%   71.49%           
=======================================
  Files          77       77           
  Lines        8378     8378           
=======================================
  Hits         5990     5990           
  Misses       2388     2388

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

mashehu
mashehu approved these changes Jan 27, 2023
View reviewed changes
nf_core/pipeline-template/docs/usage.md Outdated Show resolved Hide resolved
nf_core/pipeline-template/docs/usage.md Outdated Show resolved Hide resolved
@jfy133 @mashehu
Apply suggestions from code review
5e16056 
Co-authored-by: Matthias Hörtenhuber <mashehu@users.noreply.github.com>
@jfy133 @d4straub
Update nf_core/pipeline-template/docs/usage.md
579a0c3 
Co-authored-by: Daniel Straub <42973691+d4straub@users.noreply.github.com>
@jfy133 jfy133 requested a review from d4straub January 30, 2023 09:52
d4straub
d4straub approved these changes Jan 30, 2023
View reviewed changes
Copy link
Contributor

@d4straub d4straub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jfy133 jfy133 merged commit 110cec8 into dev Jan 30, 2023
@jfy133 jfy133 deleted the params-file-docs2 branch January 30, 2023 12:09
@grst grst mentioned this pull request Feb 16, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@d4straub d4straub d4straub approved these changes

@mirpedrol mirpedrol mirpedrol approved these changes

@mashehu mashehu mashehu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jfy133 @mashehu @mirpedrol @d4straub @nf-core-bot